Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Uv #11148 Add last updated field to docs #11162

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Uv #11148 Add last updated field to docs #11162

wants to merge 2 commits into from

Conversation

LEvinson2504
Copy link

@LEvinson2504 LEvinson2504 commented Feb 2, 2025 •
edited
Loading

Summary

We want to add last updated time to the docs, it indicates when the last commit to the doc page was done. ref: #11148

Test Plan

  1. Ran cargo test --doc
  2. Did mkdocs serve to view the result locally

@LEvinson2504
astral-sh#11148 @10m Added mkdocs-git-revision-date-localized-plugin …
58b36ec 
…for last edit time to show up on mkdocs documentation.
@LEvinson2504
astral-sh#11148 @5m ran pip compile on docs/requirements.txt and remo…
97cdb4a 
…ved manual entry to requirements.txt
@LEvinson2504 LEvinson2504 changed the title Uv 11148 levinson Uv #11148 levinson Feb 2, 2025
@LEvinson2504 LEvinson2504 changed the title Uv #11148 levinson Uv #11148 Add last updated field to docs Feb 2, 2025
@konstin konstin requested a review from zanieb February 2, 2025 11:02
@FishAlchemist FishAlchemist mentioned this pull request Feb 2, 2025
Merged
charliermarsh pushed a commit that referenced this pull request Feb 4, 2025
@FishAlchemist
Add last updated for document (#11164)
49b85d2 
## Summary

![image](https://github.com/user-attachments/assets/75431f9f-debe-435d-a02e-d216be7a3a01)

![image](https://github.com/user-attachments/assets/2d1b895e-4878-410e-90ff-ff8e932cbf24)
Display the last document update time, excluding any automatically
generated parts of the document, while ensuring that Google can
accurately read and recognize the webpage's time.

Note that I do not have permission to update
``requirements-insiders.txt``


Google time info
*
https://developers.google.com/search/blog/2019/03/help-google-search-know-best-date-for
*
https://developers.google.com/search/docs/appearance/structured-data/article#amp

Similar #11162
Closes #11148
## Test Plan
uvx --with-requirements docs/requirements.txt -- mkdocs serve -f
mkdocs.public.yml --strict

![image](https://github.com/user-attachments/assets/6e8cd609-2e60-489c-97cc-fb28aa3204e0)
The correct format is actually ``2024-08-08T22:01:08Z``, but Google
Search happens to be lenient and accepts this format.

![image](https://github.com/user-attachments/assets/2ec8ce98-49ea-403b-bbd2-3d0d5630a562)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zanieb zanieb Awaiting requested review from zanieb

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@LEvinson2504